Update AI-assisted coding guidelines in CONTRIBUTING.md#1439
Update AI-assisted coding guidelines in CONTRIBUTING.md#1439
Conversation
Because it's getting way too much, man.
.github/pull_request_template.md
Outdated
| * Consider adding the `no-deploy` label if this PR shouldn't be deployed and does not alter the data served by the API. | ||
| --> | ||
|
|
||
| - [ ] I have read and understood the [AI Assisted Contribution guidelines](https://github.com/PokeAPI/pokeapi/blob/master/CONTRIBUTING.md#ai-assisted-coding) No newline at end of file |
There was a problem hiding this comment.
I think we should add more things to this
|
Before commenting I'll see what some popular old open source projects are doing as well. |
|
This is Ghostty's policy: https://github.com/ghostty-org/ghostty/blob/main/AI_POLICY.md Let's find some others and compare them. |
|
@Naramsim I'll get back to this when I get a free moment. For now though, major maintainers of Python and the Python ecosystem recently had this to say about AI contributions in OSS: https://pydantic.dev/articles/pyai-oss-panel Worth reading. |
|
Feedback implemented. |
| - [ ] I have written a description of the issue and explained why the fix solves the problem. | ||
| - [ ] I have written tests for my code changes. |
There was a problem hiding this comment.
This may be pedantic, but some PRs are for additions of new data (new pokemon, abilities, etc.) or new features and this is specific to fixes. Maybe something like
| - [ ] I have written a description of the issue and explained why the fix solves the problem. | |
| - [ ] I have written tests for my code changes. | |
| - [ ] I have written a description of the contribution and explained its motivation. | |
| - [ ] I have written tests for my code changes (if applicable). |
|
|
||
| ## Change description | ||
|
|
||
| <!--> Add your change description here <!--> |
There was a problem hiding this comment.
Is this supposed to be an HTML comment? I think it's a good idea, but the opening tag should be <!-- and the closing one -->
If we do like this the line is shown in the editor but no present in the rendered issue.
| The types of AI-assisted coding that will be accepted: | ||
|
|
||
| - Scaffolding for common framework patterns | ||
| - Scaffolding for test patternstest generation |
3 participants
Change description
Because it's getting way too much, man.
We need to be clearer about what is an is acceptable.
We are not here to teach people good use of LLM tooling, but we are still dealing with potentially a lot of AI miss use.
OSS and Github has fundamentally changed and there is no clear way to deal with this.
AI coding assistance disclosure
For this change, I wrote everything by hand.
Contributor check list